Create subscription

The Create Subscription API enables to create subscription for selected events which provides subscription ID upon successful creation.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
name Mandatory	String Name of the subscription Sample value: "DocTest"
callbackUrl Mandatory	String Url where notifications are posted Sample value: "http://localhost:4444/event"
events Mandatory	Array
Transaction.NEW Optional	String Event - transaction created
Transaction.UPDATE Optional	String Event - transaction status updated
Account.UPDATE Optional	String Event - account status updated
Account.NEW Optional	String Event - new account created
groupId Mandatory	Array
200146575944771 Mandatory	String Account number of the subscriber
remarks Optional	String Description if required Sample value: "Test"

cURL

curl --location '' \
--header 'Content-Type: application/json' \
--data '{"name":"DocTest","callbackUrl":"http://localhost:4444/event","events":["Transaction.NEW","Transaction.UPDATE","Account.UPDATE","Account.NEW"],"groupId":["200146575944771"],"remarks":"Test"}'

C#

var options = new RestClientOptions("")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""name"": ""DocTest"",
" + "\n" +
@"    ""callbackUrl"": ""http://localhost:4444/event"",
" + "\n" +
@"    ""events"": [
" + "\n" +
@"        ""Transaction.NEW"",
" + "\n" +
@"        ""Transaction.UPDATE"",
" + "\n" +
@"        ""Account.UPDATE"",
" + "\n" +
@"        ""Account.NEW""
" + "\n" +
@"    ],
" + "\n" +
@"    ""groupId"": [
" + "\n" +
@"        ""200146575944771""
" + "\n" +
@"    ],
" + "\n" +
@"    ""remarks"": ""Test""
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := ""
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "name": "DocTest",`+"
"+`
    "callbackUrl": "http://localhost:4444/event",`+"
"+`
    "events": [`+"
"+`
        "Transaction.NEW",`+"
"+`
        "Transaction.UPDATE",`+"
"+`
        "Account.UPDATE",`+"
"+`
        "Account.NEW"`+"
"+`
    ],`+"
"+`
    "groupId": [`+"
"+`
        "200146575944771"`+"
"+`
    ],`+"
"+`
    "remarks": "Test"`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '',
  'path': '/',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "name": "DocTest",
  "callbackUrl": "http://localhost:4444/event",
  "events": [
    "Transaction.NEW",
    "Transaction.UPDATE",
    "Account.UPDATE",
    "Account.NEW"
  ],
  "groupId": [
    "200146575944771"
  ],
  "remarks": "Test"
});

req.write(postData);

req.end();

Body

{
  "name": "DocTest",
  "callbackUrl": "http://localhost:4444/event",
  "events": [
    "Transaction.NEW",
    "Transaction.UPDATE",
    "Account.UPDATE",
    "Account.NEW"
  ],
  "groupId": [
    "200146575944771"
  ],
  "remarks": "Test"
}

Response: 200

Payload Parameters

Parameter	Description
response	String Response Message Sample value: "Subscription created"
subscriptionId	String Generated Unique Subscription ID Sample value: "SUB162948"

{
  "response": "Subscription created",
  "subscriptionId": "SUB162948"
}